$ID
$ID : string
Class name of the plugin instance
Plugin interface class
$ID : string
Class name of the plugin instance
$api : \rcube_plugin_api
Instance of Plugin API
$task : string
Regular expression defining task(s) to bind with
$noajax : bool
Disables plugin in AJAX requests
$noframe : bool
Disables plugin in framed mode
$allowed_prefs : array
A list of config option names that can be modified by the user via user interface (with save-prefs command)
$home : string
$urlbase : string
$mytask : string
$loaded_config : array
info() : array
Provide information about this
Meta information about a plugin or false if not implemented. As hash array with the following keys: name: The plugin name vendor: Name of the plugin developer version: Plugin version name license: License name (short form according to http://spdx.org/licenses/) uri: The URL to the plugin homepage or source repository src_uri: Direct download URL to the source code of this plugin require: List of plugins required for this one (as array of plugin names)
register_action(string $action, mixed $callback) : mixed
Register a handler for a specific client-request action
The callback will be executed upon a request like /?_task=mail&_action=plugin.myaction
string | $action | Action name (should be unique) |
mixed | $callback | Callback function as string or array with object reference and method name |
register_handler(string $name, mixed $callback) : mixed
Register a handler function for a template object
When parsing a template for display, tags like <roundcube:object name="plugin.myobject" /> will be replaced by the return value if the registered callback function.
string | $name | Object name (should be unique and start with 'plugin.') |
mixed | $callback | Callback function as string or array with object reference and method name |
local_skin_path(string $extra_dir = null, mixed $skin_name = null) : string
Provide path to the currently selected skin folder within the plugin directory with a fallback to the default skin folder.
string | $extra_dir | Additional directory to search in (optional) |
mixed | $skin_name | Specific skin name(s) to look for, string or array (optional) |
Skin path relative to plugins directory